home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 February / Macworld (1999-02).dmg / Serious Demos / XTension demo / XTension manual 2.0 / XTension manual 2.0.rsrc / TEXT_168.txt < prev    next >
Text File  |  1998-07-18  |  4KB  |  115 lines
  1.  
  2. Creating and using 'Plug-Ins'         
  3.  
  4. About Plug-ins 
  5.  
  6. Suppose you have an irrigation system, and a rain gauge, and you
  7. want to want to incorporate it into your XTension system.
  8.  
  9. These are closely related systems, and much can be done to daily
  10. modify the amount of water that your plants need.  But it may take
  11. you some time to create all of the scripts and units and scheduled
  12. events that would make it really useful.
  13.  
  14. Much of the work could have already been done for you by someone
  15. who created such a system and then 'exported' all of the elements
  16. that you would have to create yourself.
  17.  
  18. You will probably have to modify any of these plug-ins to adapt
  19. to the addresses and names that you use in your system already,
  20. but it is easier to modify something than to create it from scratch.
  21.  
  22. A 'plug-in' is a file that includes a selection of units, scripts, views,
  23. lists, and scheduled events which represent all or most of what is
  24. relevant to a particular 'sub system' such as "Irrigation System".
  25.  
  26. Some plug-ins may assume that you have already imported others.
  27. Like "Irrigation System" may assume that you already have imported
  28. the "Rain Gauge" plug-in, or vice-versa.
  29.  
  30. After having created and tested a 'sub-system', you might want to 
  31. publish it, share it, sell it, or just save it for yourself.
  32.  
  33.  
  34. Creating Plug-ins 
  35.  
  36. By selecting "Export ..." from the Database menu, you will be presented
  37. with a series of selection dialogs.
  38.  
  39. You will be asked to choose which elements of your system that you 
  40. want to include in the 'plug-in'.
  41.  
  42. These elements include :
  43.                     ‚Ä¢  Views
  44.                     ‚Ä¢  Groups
  45.                     ‚Ä¢  Events
  46.                     ‚Ä¢  Units
  47.                     ‚Ä¢  Global scripts
  48.                     ‚Ä¢  the name of the 'plug-in'
  49.  
  50. As you choose from the views, groups and events, each of the 'units'
  51. that are called-upon in those, will be automatically selected as individual
  52. units to be exported.
  53.  
  54. When you get to the 'Units' selection page, you will be presented with
  55. a choice of all database units which are not already included by some 
  56. previous view, group or event.
  57.  
  58. Unit scripts will be automatically exported with their respective units,
  59. if they exist.
  60.  
  61. Global scripts are selected individually, and it is assumed that they 
  62. contain references to units and scripts which are already included
  63. in the plug-in, or that they are common to all systems.
  64. ie :  daylight, or time/date etc.
  65.  
  66. Finally, you will be asked for a name of the plug-in, and where you
  67. want to save it.  
  68.  
  69. You should always create a help file for a plug-in.  Tell others what
  70. addresses and names you assumed, and perhaps any startup instructions.
  71.  
  72. You should have a good idea of what you want to export before you 
  73. start the process, but do remember that you can cancel out at any time.
  74. There is no way to add elements to a plug-in once it has been created.
  75.  
  76. Importing Plug-ins
  77.  
  78. After receiving an XTension plug-in from a friend, and you have read
  79. the 'help file' for it,  simply pull down the Database menu and select "Import...".
  80.  
  81. You will be asked to select the plug-in file, and if it is the proper format,
  82. XTension will then ask you:
  83.  
  84. Do you want to overwrite all units in your receiving database which
  85. have names which are identical to names in the 'plug-in' ?
  86.  
  87. Some of the units in the plug-in may be redundant, and you may have
  88. the choice to keep some of your 'old faithful's .
  89.  
  90. You can choose to :
  91.                    ‚Ä¢  Always use new
  92.                    ‚Ä¢  Always keep the old
  93.                    ‚Ä¢  Let me choose as conflicts occur
  94.  
  95. Once you have imported a plug-in, you will see a new 'List' window
  96. which includes all of the units which were imported with the plug-in.
  97. It will also have the same name as the plug-in.  Remember that you
  98. can always change the name of a List.
  99.  
  100. You will most likely have to change the addresses of any X-10 units,
  101. but you can either change the database, or change the modules directly.
  102.  
  103. You may also want to change the times and weekdays for some of the
  104. scheduled events to match your preferences.
  105.  
  106. Plugs-ins are not expected to be perfectly effortless to import, however
  107. they are a great way to get started, and a great way to share.
  108.  
  109. DO REMEMBER to save a copy of your current database before you
  110. import any plug-in ( as before any major change to your system ).
  111.  
  112. There is no way to UNDO an import other than to revert to a 
  113. saved database copy.
  114.  
  115.